mudbox::Exporter Class Reference

#include <importexport.h>

Inheritance diagram for mudbox::Exporter:

Detailed Description

This class is the base class for plugins that export mesh geometry from Mudbox.

To create a new exporter plugin, derive your own class from this one and implement it. Use the DECLARE_CLASS and IMPLEMENT_CLASS macros to provide information about your exporter to Mudbox. Once this is done, Mudbox will know enough about your class to use it. When the user wants to export a new file, mudbox will recognize your specified extension.

At this time, only mesh objects are supported. During an export operation, Mudbox first calls SetMeshCount() and SetMesh() to specify which meshes should be exported. Finally, it calls the Export() function to do the work.


Public Member Functions
virtual const mudbox::ClassDesc *	RuntimeClass (void) const
virtual QString	Extension (void)
	Returns the file extension written by this exporter.
virtual QString	Description (void)
	Returns a small text description of your file type.
virtual void	Export (const QString &sFileName)
	Export the specified meshes.
virtual void	SetMeshCount (unsigned int iMeshCount)
	Tells the exporter how many meshes are to be exported.
virtual void	SetMesh (unsigned int iIndex, const Mesh *pMesh)
	Specifies which mesh(es) should be exported. This is called once per mesh, after Mudbox has called SetMeshCount(). In your overridden class, you do not need to store all the Mesh data. Instead, you can just store pointers to the appropriate meshes and then access their data in the Export() method.
Static Public Member Functions
const mudbox::ClassDesc *	StaticClass (void)
mudbox::Node *	CreateInstances (unsigned int iCount=1)

Member Function Documentation

virtual const mudbox::ClassDesc* mudbox::Exporter::RuntimeClass ( void ) const [inline, virtual]

Reimplemented from mudbox::Node.

00104 : "ply".

const mudbox::ClassDesc* mudbox::Exporter::StaticClass ( void ) [static]

Reimplemented from mudbox::Node.

mudbox::Node* mudbox::Exporter::CreateInstances ( unsigned int iCount = 1 ) [static]

Reimplemented from mudbox::Node.

virtual QString mudbox::Exporter::Extension ( void ) [virtual]

Returns the file extension written by this exporter.

Override this function to make it return the extention of the file type you write, for example: "ply". At this time only a single extension is supported.

virtual QString mudbox::Exporter::Description ( void ) [virtual]

Returns a small text description of your file type.

Override this function to make it return return a small description which will appear in the browse dialog.

virtual void mudbox::Exporter::Export ( const QString & sFileName ) [virtual]

Export the specified meshes.

This function will be called after Mudbox calls SetMeshCount() and SetMesh() to provide your class with all the needed mesh data. Override this method to make it do the actual writing of your file type.

Parameters:

sFileName

[in] The path of the file to be written

virtual void mudbox::Exporter::SetMeshCount ( unsigned int iMeshCount ) [virtual]

Tells the exporter how many meshes are to be exported.

Parameters:

iMeshCount

[in] Number of meshes that will be exported

virtual void mudbox::Exporter::SetMesh	(	unsigned int	iIndex,
		const Mesh *	pMesh
	)	`[virtual]`

Specifies which mesh(es) should be exported. This is called once per mesh, after Mudbox has called SetMeshCount(). In your overridden class, you do not need to store all the Mesh data. Instead, you can just store pointers to the appropriate meshes and then access their data in the Export() method.

Parameters:

iIndex	[in] Index of the specified mesh
pMesh	[in] the specified mesh

mudbox::Exporter Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Member Function Documentation